home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / pdriver5.arc / READ.ME < prev    next >
Text File  |  1989-12-17  |  12KB  |  276 lines
  1.         Release 5.0 of the Clarkson packet drivers
  2.  
  3. If you are a user, all you need do is locate the correct packet driver for your
  4. interface, and read DRIVERS.DOC.
  5.  
  6.  
  7. Versions:
  8.  
  9. If you already have an older packet driver, you may wish to upgrade.  You
  10. should base this decision on the contents of the "Changes..." section
  11. below.  The major version (currently 5) goes up with every release.  The
  12. minor version (.x, different for every driver) goes up with every
  13. significant change in the device dependent part.  Three drivers, the
  14. 3c523, ni5210, and ni9210, all depend on 82586.asm, so they have a
  15. subminor version number which is the version of 82586.asm.  If the minor
  16. version hasn't changed, then chances are very good that no significant
  17. bugs have been introduced.  Sometimes the file is changed without changing
  18. the version number.  This is done only when an identical change is made to
  19. all drivers to fix a bug that appears in every driver.
  20.  
  21. 3C501.ASM    version    equ    0
  22. 3C503.ASM    version    equ    2
  23. 3C505.ASM    version    equ    0
  24. 3C523.ASM    version    equ    1
  25. 82586.ASM    i82586_version    equ    0
  26. GENERIC.ASM    version    equ    0
  27. ISOLAN.ASM    version    equ    1
  28. NE1000.ASM    version    equ    2
  29. NI5010.ASM    version    equ    0
  30. NI5210.ASM    version    equ    2
  31. NI9210.ASM    version    equ    0
  32. SLIP8250.ASM    version    equ    3
  33. TRACE.ASM    version    equ    0
  34. WD8003E.ASM    version    equ    4
  35.  
  36.  
  37. Contents:
  38.  
  39. There are now two packet driver distributions.  The smaller one,
  40. drivers.arc, contains only the executable programs on the list below, this
  41. file, DRIVERS.DOC, and COPYING.  The larger one, driverss.arc, contains
  42. all of the files listed below.
  43.  
  44. 3C501.ASM     Device dependent 3COM 3C501 code.
  45. 3C501.COM
  46. 3C503.ASM     Device dependent 3COM 3C503 code.
  47. 3C503.COM
  48. 3C505.ASM     Device dependent 3COM 3C505 code.
  49. 3C523.ASM     Device dependent 3COM 3C523 code.
  50. 3C523.COM
  51. 82586.ASM     Include file for drivers based on the 82586.
  52. COPYING       The Free Software Foundation's General Public License.
  53. DEFS.ASM      Definitions and macros.
  54. DRIVERS.DOC   User documentation.
  55. DUMP.C        Source of the trace dumper.
  56. DUMP.EXE
  57. GENERIC.ASM   Device dependent generic code (a skeleton only).
  58. HEAD.ASM      Resident device independent generic code.
  59. IBMTOKEN.ASM  Device dependent IBM Token Ring Adapter code.
  60. IBMTOKEN.COM
  61. IBMTOKEN.DOC
  62. ISOLAN.ASM    Device dependent BICC Isolan 4110 code.
  63. ISOLAN.COM
  64. MAKEFILE      Makefile.  Uses tasm and tlink, but MS may work.
  65. NE1000.ASM    Device dependent Novell NE1000 code.
  66. NE1000.COM
  67. NI5010.ASM    Device dependent Interlan NI5010 code.
  68. NI5010.COM
  69. NI5210.ASM    Device dependent MICOM-Interlan NI5210 code.
  70. NI5210.COM
  71. NI9210.ASM    Device dependent MICOM-Interlan NI9210 code.
  72. NI9210.COM
  73. PACKETQA.TXT  Questions from R. Nelson and Answers from jbvb@vax.ftp.com
  74. PACKET_D.108  Packet driver spec version 1.08
  75. PKTADDR.ASM   Program to get/set the packet driver address.
  76. PKTADDR.COM
  77. PKTALL.ASM    Program to receive and discard all packets.
  78. PKTALL.COM
  79. PKTCHK.ASM    Source of the packet driver installation checker.
  80. PKTCHK.COM
  81. PKTMODE.ASM   Program to get/set the packet driver receive mode.
  82. PKTMODE.COM
  83. READ.ME       This file.
  84. README.503    Bob Clements' README file for the 3c503.
  85. README.505    README file for the 3c505.
  86. README.WD8    Jan Engvald's README file for the WD8003ET/A.
  87. SLIP8250.ASM  Device dependent SLIP driver using IBM-PC 8250.
  88. SLIP8250.COM
  89. STAT.C        Source of the statistics printer.
  90. STAT.EXE
  91. SUPPORT.TXT   Who supports the packet driver spec.
  92. TAIL.ASM      Non-resident device independent generic code.
  93. TERMIN.ASM    Source of the packet driver terminator.
  94. TERMIN.COM
  95. TRACE.ASM     Source of the packet driver tracer.
  96. TRACE.COM
  97. WD8003E.ASM   Device dependent Western Digital WD-8003e code.
  98. WD8003E.COM
  99.  
  100.  
  101. Editor's note:
  102.  
  103. I created the infrastructure for the packet drivers.  All of the device
  104. dependent portions were written by other people.  The best term to
  105. describe what I do is "Editor and publisher", because I perform a function
  106. similar to that served in the literary world.
  107.  
  108. Please direct bug reports to me.  Chances are that the bug is in my code
  109. anyway.  If not, I'll forward the bug report on to the device driver author.
  110. As with all free software, no guarantee of support is given.
  111.  
  112. Russell Nelson, Editor of the Clarkson packet drivers.
  113. nelson@clutx.clarkson.edu, nelson@clutx.bitnet
  114.  
  115.  
  116. Bugs:
  117.  
  118. I have had bug reports for the 3c505, ni9210, and ni5210.  I have also had
  119. reports that they work just fine.  The ni5210 driver works just fine for
  120. me, but it eventually crashes when installed on a machine that typically
  121. has twenty simultaneous users.  Why am I shipping buggy software?  Because
  122. I am unable to test it.  I just don't have the right hardware.
  123.  
  124.  
  125. Changes from version 4.0 to 5.0 of the drivers:
  126.  
  127. Summary: New: 3c505, ne1000, ni9210, ibmtoken.  Bugs fixed: all drivers.
  128.  
  129. Krishnan Gopalan and Gregg Stefancik wrote a packet driver for the 3c505.
  130. Brian Fisher wrote an "Ethernet" packet driver for the IBM Token Ring Adapter.
  131. Eric Henderson wrote a packet driver for Novell's NE1000.
  132. Russell Nelson modified ni5210 to be a ni9210 driver.  This entailed some
  133.     changes in 82586.asm.
  134. Russell Nelson wrote pktmode, a utility to set the receive mode.
  135. Russell Nelson wrote pktaddr, a utility to set the Ethernet address.
  136. Russell Nelson wrote pktall, a utility to help debug packet reception.
  137. Trace.com is a little bit more helpful about how to run it.
  138. Vance Morrison added starlan support to the wd8003e driver.
  139. Eric Henderson improved it.
  140. Deborah Swanberg noticed that the 3c503 driver didn't timeout properly
  141.     if there was a failure to complete a transmit.
  142. The set_address routine in the device dependent files now
  143.     returns the address length as it should have.
  144. Head.asm now keeps a copy of the hardware address set by set_address.  This is
  145.     used by f_get_address to return the current address.  The device
  146.     dependent get_address routine always returns the PROM address.
  147. The set_rcv_mode routine didn't work.  Not at all.
  148. The access_type routine returns more appropriate errors.
  149. The f_get_address routine wasn't passing the right address length to
  150.     get_address.
  151. Tail.asm now checks for extra parameters on the end of the line.
  152. Dan Lanciani added changes to ni5210 version 4.2 to increase reliability.
  153.     It works for him.  Unfortunately, I have had reports from other
  154.     people that it breaks Novell.  So, these changes are in "if DAN"
  155.     conditional assembly.  If your Novell connection gets dropped,
  156.     try reassembling ni5210 after setting "DAN equ 0" in 82586.asm
  157. Packet drivers for the NE2000 and UB NIC PC/2 are in the works, but don't
  158.     hold your breath.
  159. A packet driver for the Xircom pocket Ethernet adapter is undergoing testing.
  160. Jan Engvald found and fixed a bug in the wd8003e memory presence check.
  161.  
  162.  
  163. Changes from version 3.0 to 4.0 of the drivers:
  164.  
  165. Russell Nelson added code to enable interrupts in the body of the packet
  166.     driver.
  167. Denis DeLaRoca added hardware handshake to the SLIP8250 driver.
  168. John Grover optimized the SLIP8250 driver to work at 38.4 Kbps.
  169. Russell Nelson added some sanity checking to slip8250 to warn the user about
  170.     possible incorrect parameters.
  171. Bob Clements added a switch to select thick or thin Ethernet in the 3c503.
  172. Russell Nelson found a minor bug in NI5210 that caused it to fail to
  173.     initialize sometimes.  Thanks to everyone who reported it.
  174. Dan Lanciani found a race condition in the 80586 code common to the
  175.     NI5210 and 3c523 drivers.
  176. Russell Nelson split out the 82586 code from the NI5210 and 3c523 drivers
  177.     into a single file.
  178. Russell Nelson added memory address checking to NI5210.
  179. Glen M. Marianko devised a method for determining the memory size of the
  180.     NI5210 automagically.
  181. Jan Engvald enhanced the packet driver code for Western Digital Ethernet
  182.     cards to handle the micro channel version WD8003ET/A.
  183. Jan Engvald enhanced TAIL.ASM to return error codes to DOS.
  184. Jan Engvald enhanced HEAD.ASM to be aware of running on a MicroChannel bus.
  185. Rainer Toebbicke wrote the BICC Data Networks' ISOLAN 4110 ethernet driver.
  186. Russell Nelson wrote the packet driver tracer and dumper (trace.com and
  187.     dump.exe).
  188. Russell Nelson added support for set_rcv_mode, get_rcv_mode,
  189.     set_multicast_list, and get_multicast_list to the infrastructure.  It
  190.     is up to the individuals who wrote the individual drivers to add the
  191.     device-dependent support.
  192.  
  193.  
  194. Changes from version 2.0 to 3.0 of the drivers:
  195.  
  196. GNU General Public License adopted.  The restriction on commercial usage
  197.      prevented some companies from distributing the packet drivers.  This
  198.      is entirely my idea, so send any comments to nelson@clutx.clarkson.edu.
  199. 3c523 driver added, thanks to Dan Lanciani (ddl@harvard.edu).
  200. Gregg Stefanik (wstef@eng.clemson.edu) is working on a 3c505 driver.  Don't
  201.      bug him about it unless you're willing to be a alpha tester.
  202. User documentation added (DRIVERS.DOC).
  203. Brad Clements (no relation to Bob Clements) fixed the NI5210 driver so that
  204.      it will work with a MTU of 1500.
  205. The NI5210 now checks for shorts and opens before it starts up, thanks to
  206.      Brad.
  207. All memory-mapped packet drivers now check the packet length in send_pkt to
  208.      ensure that too-long packets get trapped.  All packet drivers will
  209.      work with MTUs of 1500 (plus 14 bytes of Ethernet header).
  210. Deborah Swanberg noticed that attach_type was returning NO_CLASS
  211.      when it meant to return NO_TYPE.
  212. She also noted that packet drivers weren't returning unique handles.  This
  213.      is only a problem with Phil Karn's code, as his code directs *every*
  214.      packet driver to the same receiver routine.  With non-unique handles,
  215.      it was impossible to tell which packet driver was upcalling the
  216.      receiver.  Unique handles are now generated, based on the starting
  217.      segment of the driver.  The latest version of Karn's code uses different
  218.      receiver routines, so the code to implement this will eventually go away.
  219. Tail.asm now prints the Ethernet address of the interface (if it is an Ethernet
  220.      class device)
  221. Micom has sold Interlan, and Racal has bought it, so perhaps the NI5210 is
  222.      now the Racal-Interlan NI5210?
  223. If anyone is interested in using the Zenith Z-100 with a SLIP packet driver, please
  224.      send me (Russell Nelson) mail.  I have it partially written, but will
  225.      probably never use it myself.
  226. WD8003E and 3c503 sped up slightly -- stole movemem from NI5210.
  227.  
  228.  
  229. Changes from version 3 to 2.0 of the drivers:
  230.  
  231. Version numbering now changed.  If the skeleton changes, the major version is
  232.      incremented and all the minor versions are reset to zero.
  233.  
  234. Support for version 1.08 of the packet driver spec included.
  235. Bob Clements' 3c503 driver added.  See README.503.
  236. Some comments improved.
  237. BAD_COMMAND checking code fixed.
  238. cld instructions added to ensure that DF=0.
  239. NI5210 sped up slightly -- look at movemem in ni5210.asm for an especially
  240.      fast routine to move memory around.
  241.  
  242.  
  243. Changes from version 2 to 3 of the drivers:
  244.  
  245. SLIP8250 can now be one of three classes: SLIP, AX.25, and KISS.
  246. Tail.asm now checks for a packet driver already at the given interrupt.
  247. Tail.asm now echoes its arguments in hex and decimal.
  248. Tail.asm will close stdout so that a file handle won't be used up in
  249.      case the user redirects stdout to NUL.
  250. Head.asm now supports driver termination.
  251. Termin.com added to terminate a driver.
  252. Head.asm now does a stack swap to avoid pushing too many things when
  253.      interrupting MS-LOSS.
  254.  
  255.  
  256. Changes from version 1 to 2 of the drivers:
  257.  
  258. !!  Arguments are now in decimal by default  !!  Use a 0x prefix for hex.
  259.  
  260. DEFS.ASM created.
  261. The loadport macro improved.
  262. SLIP8250 driver added, thanks for a C version from Phil Karn.
  263.      I've tried to put some 16550 support in, but I don't have one to
  264.      test it with.  The documentation insists the TBRE goes low when
  265.      the transmit buffer is not empty, while it makes sense for it to stay
  266.      high while the buffer is not full.  I suspect the documentation is
  267.      wrong.
  268. NI5010 driver added, thanks for a C version from Bill Doster.
  269. WD8003 driver added, by Bob Clements.
  270. Loadport macro added to WD8003 driver by Russell Nelson.
  271. Numeric arguments may now be specified in octal, decimal or hex, using the
  272.      C notation.
  273. Numeric arguments can now use up to 32 bits.
  274. Source files reformatted.
  275.  
  276.